Polish component docs #153
Conversation
There was a problem hiding this comment.
Component docs look good. I'm noticing a couple of spacing issues that are probably not related to this particular PR, but calling them out just in case:
- Need more spacing between the global nav and the sidebar/content columns
- Need more spacing + a vertical border between the sidebar and content columns
|
i'm finding the nested prop types a little confusing to looks at, have we talked about having borders similar to one core? I also find the closing |
|
I'm open to putting the borders between the different elements. I hesitated doing it only because I was on the fence about the short border when the prop type is nested. Do you think it would be better to omit the |
| CodeDef.Block = Block; | ||
| CodeDef.Bracket = Bracket; | ||
| CodeDef.Comment = Comment; | ||
| CodeDef.Keyword = Keyword; | ||
| CodeDef.Identifier = Identifier; | ||
| CodeDef.Number = NumberValue; | ||
| CodeDef.Operator = Operator; | ||
| CodeDef.String = StringValue; | ||
| CodeDef.Type = Type; |
There was a problem hiding this comment.
Good call on doing this for the reuse/flexibility/consistency 💯
|
@LizBaker I removed the borders in a previous PR, but you're right, the nested props get kind of crazy without them. What if we tried indenting the props the way they're indented in the One Core docs, to emphasize that they're grouped together more? |
|
🎉 This PR is included in version 1.0.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
Description
Fully polishes the component documentation with various refactors to ensure consistency.
Reviewer Notes
Visit a component such as the
<Button />: https://pr-153.dlyi50rq9kt6c.amplifyapp.com/components/buttonSome components worth looking at:
/apis/nerdlet=> Has constants/components/table-header-cell=> Has wrapping prop default value/components/entity-count-query=> Nested prop types/components/nrql-query=> Has type defsRelated Issue(s) / Ticket(s)
If there are any related GitHub Issues or JIRA tickets, add links to them here.
Screenshot(s)